home *** CD-ROM | disk | FTP | other *** search
/ Amiga Collections: Auge 4000 / Auge 4000 #45 (1990-06-20)(Amiga User Gruppe Einzugsgebiet 4000).zip / Auge 4000 #45 (1990-06-20)(Amiga User Gruppe Einzugsgebiet 4000).adf / ANWENDUNGEN / Ncomm / host / host.doc < prev    next >
Text File  |  1990-06-08  |  12KB  |  280 lines
  1.                 ===============================
  2.                 NComm Host Script Documentation
  3.                 ===============================
  4.  
  5.    The NComm Host Script was written by Daniel Bloch 1989.
  6.          Documentation written by Torkel Lodberg.
  7.  
  8.    The original plan was to implement the NComm host mode as a part
  9. of the NComm program, but, since the program would grow _large_,
  10. the host mode was implemented as a script. Of course, the NComm
  11. script language had to be enhanced, and functions specifically
  12. needed for the project were implemented. The result is one of
  13. the most powerful host modes available by any communication
  14. program...
  15.  
  16.                 How to set up NHS
  17.                 =================
  18.  
  19.    Before setting up NHS, please assure that the following files are
  20. available; 'C:ZOO', 'C:DELETE', 'C:FILENOTE', 'C:EXECUTE' and 'C:COPY'.
  21.  
  22.    To set up NHS, a few changes have to be made to the 'host.script'.
  23. All variables that need to be maintained have been placed at top
  24. of the script. First, a few directory names have to be defined. All
  25. directory names should end with a colon or a slash, and the directories
  26. must exist before you start using the script.
  27.  
  28.    The variable '$dir' shall contain the name of the directory where
  29. all miscellaneous files are kept. In other words, this is where
  30. bulletins, menus, messages, textfiles and so on have to rely. The
  31. NComm Host Script will log all user operations in a log file that
  32. will be created in this directory.
  33.  
  34.    The variable '$uldir' shall contain the name of the NHS upload
  35. directory - all files uploaded will be placed here.
  36.  
  37.    The variable '$dldir' shall contain the name of the NHS download
  38. directory - copy the files which shall be available for download
  39. into this directory. Use the command 'FILENOTE' for adding file
  40. descriptions. If '$uldir' and '$dldir' point to the same directory,
  41. files uploaded will be available for download immediately. Otherwise,
  42. the files have to be moved to the '$dldir' directory.
  43.  
  44.    The variable '$hold' shall contain the name of the NHS hold
  45. directory. All ZOO files extracted will be placed in this directory.
  46. Please notice that existing HOLD files wil be deleted at
  47. initialization, do not store other files in this directory!
  48.  
  49.    Now, a few file names have to been defined. The variable '$holdzoo'
  50. shall contain the name of the temporary hold ZOO file. Files will be
  51. added to this file.
  52.  
  53.    The variable '$tmp' shall contain the name of the temporary text
  54. file used by NHS for file listings and so on.
  55.  
  56.    The variable '$passwd' shall contain the user password. Users
  57. who do not have knowledge about this password will be conveyed right
  58. off the board.
  59.  
  60.    The variable '$sysop' shall contain the SYSOP name. Use this
  61. account for gaining SYSOP privileges - restricted commands can only
  62. be accessed when using this account.
  63.  
  64.    The variable '$syspass' shall contain the SYSOP password.
  65.  
  66.    The variable '$sysname' shall contain the name of your system.
  67.  
  68.    Finally, specify the name of the directory lister in the
  69. variable '$list'.  This will normally be C:List.
  70.  
  71.    A few changes also have to be made to the NComm configuration.
  72. End-Of-Line TX should be set to CR+LF, the character set should be
  73. set to ISO and G&R Host Mode has to be ENABLED. You should use a
  74. two colour screen for faster screen updates. The G&R download dir
  75. MUST be set to the directory specified in the variable '$dldir'.
  76. This is due to Zmodem downloads always being created in the current
  77. download directory. Save the configuration as "host.config" and
  78. place it in the directory used for miscellaneous files. A sample
  79. configuration file has been included.
  80.  
  81.    NHS will display two files at logon. The file "prelog" contains
  82. the actual login text, "postlog" will be displayed after a successful
  83. login... Edit them to suit your needs.
  84.  
  85.    All menus are stored as textfiles. The file "menu0" contains
  86. the main menu, "menu1" contains a list of file transfer commands
  87. and finally "menu3" contains the SYSOP commands. Example files
  88. have been included.
  89.  
  90.    To install bulletins, simply create files "bull1", "bull2" and
  91. so on. You must also remember to edit the bulletin menu, which
  92. is contained in the text file "menu2". Again, example files have been
  93. included.
  94.  
  95.                 Using the NComm Host Script
  96.                 ===========================
  97.  
  98.    Execute the 'host.script' using the Execute Script function.
  99. If all files and directories have been created successfully,
  100. the modem will be initialized and a small menu will appear on
  101. screen. You may enter 'Q' to quit the NComm Host Script, or
  102. 'SPACE' for logging on locally. Remember to turn off the modem
  103. before logging on, otherwise the text will be echoed back from
  104. the modem.
  105.  
  106.    The NComm Host Script does not support Page Break, so use
  107. CTRL-S and CTRL-Q for halting / resuming text output.
  108.  
  109.    When logging in, the file 'prelog' will be displayed. The
  110. host will now prompt you for your name. Log on with your SYSOP name
  111. if you want to gain SYSOP privileges, or use another name to log on
  112. as a user. Enter the password that has been configured in the
  113. "host.script" file at the 'Password' prompt. The second time you enter
  114. an uncorrect password, you will be thrown off the board. You will also
  115. be thrown off the board after 5 minutes of inactivity. If you used
  116. the correct password, the file 'postlog' will be displayed...
  117.  
  118.    Press 'Enter' to continue - NHS will now display the main menu.
  119. Here is a description of the different commands available;
  120.  
  121.  
  122. MAIN MENU                                                  File; "menu0"
  123. ========================================================================
  124.  
  125. [G]oodbye
  126.                         Brings up a prompt asking you if you want to log
  127.                         off  the  system or not.  The hangup string will
  128.                         be  sent to the modem if the answer is positive.
  129.                         NHS will start waiting for the next caller.
  130.  
  131. [B]ulletins
  132.                         Displays  the  bulletin  menu.  A description of
  133.                         bulletin menu commands follows further down.
  134.  
  135. [F]iles
  136.                         Displays  the  file menu.  A description of file
  137.                         menu commands follows further down.
  138.  
  139. [O]perator page
  140.                         Will  ring  the bell for SYSOP at local console.
  141.                         When  chatting,  you may return to the main menu
  142.                         by pressing CTRL-Z.
  143.  
  144. [C]omment to SYSOP
  145.                         Enters  comment  into system.  Prompts you for a
  146.                         subject.   You  will  then  enter  a simple line
  147.                         editor  that  must  be  used  for  entering your
  148.                         comment.   Press  CTRL-Z  on  a  blank line when
  149.                         finished.  The message will be added to the file
  150.                         'comments'  -  it can be read by using the SYSOP
  151.                         command [R]ead private messages.
  152.  
  153. [E]nter message
  154.                         Enters  message  into  system.   Prompts you for
  155.                         receiver  and  subject.   You  will then enter a
  156.                         simple   line  editor  that  must  be  used  for
  157.                         entering  your message.  Press CTRL-Z on a blank
  158.                         line  when  finished.  The message will be added
  159.                         to the file 'messages' - it can be read by using
  160.                         the command [R]ead public messages.
  161.  
  162. [RE]ply message
  163.                         Actually  a  duplicate  of  the  [E]nter message
  164.                         command. See above.
  165.  
  166. [R]ead public messages
  167.                         Used  for  reading  messages - displays the file
  168.                         'messages' on screen.
  169.  
  170. [S]ysop functions
  171.                         Only  available  for  SYSOP.  Displays the SYSOP
  172.                         menu.   A  description  of  SYSOP  menu commands
  173.                         follows further down.
  174.  
  175. FILE MENU                                                  File; "menu1"
  176. ========================================================================
  177.  
  178. [ADD] file to HOLD
  179.                             Prompts  you  for  a filename. The file will
  180.                             be added to the HOLD directory.
  181.  
  182. [DIR] List files in HOLD
  183.                             Displays the contents of the HOLD directory.
  184.  
  185. [EXT]ract ZOO file to HOLD
  186.                             Prompts you  for  a  filename. The file must
  187.                             have  the extension '.ZOO'. The file will be
  188.                             extracted into the HOLD directory.
  189.  
  190. [DEL]ete file(s) from HOLD
  191.                             Prompts you for a filename. The file will be
  192.                             deleted from the HOLD directory.
  193.  
  194. [GET] files in HOLD
  195.                             Packs  the  contents  of  the HOLD directory
  196.                             into  the  hold  ZOO  file. The command will
  197.                             prompt   you   for  the  preferred  transfer
  198.                             protocol (Xmodem / YModem / Zmodem), and the
  199.                             transfer will start.
  200.  
  201. [L]ist files
  202.                             Lists the contents of the download directory
  203.                             using  the  command specified in the '$list'
  204.                             variable.
  205.  
  206. [D]ownload file
  207.                             Prompts  you  for  a  filename  and transfer
  208.                             protocol  (Xmodem  /  Ymodem  / Zmodem). The
  209.                             transfer will start.
  210.  
  211. [U]pload file
  212.                             Prompts  you  for  a  filename  and transfer
  213.                             protocol  (Xmodem  /  Ymodem  / Zmodem). The
  214.                             transfer will start.
  215.  
  216. [V]iew ZOO file
  217.                             Prompts  you  for  a filename. The file must
  218.                             have  the  extension '.ZOO'. The contents of
  219.                             the file will be displayed on screen.
  220.  
  221. [Q]uit
  222.                             Quits to main menu.
  223.  
  224.  
  225. BULLETIN MENU                                              File; "menu2"
  226. ========================================================================
  227.  
  228. [xx]
  229.          Displays bulletin #xx on screen. The file 'BULLxx' must exist.
  230.  
  231. [Enter]
  232.          Quits to main menu.
  233.  
  234.  
  235. SYSOP MENU                                                 File; "menu3"
  236. ========================================================================
  237.  
  238. [R]ead private messages
  239.                          Displays  the  file  'comments' on screen.  All
  240.                          user comments are contained here.
  241.  
  242. [L]ist user log
  243.                          Displays the file 'log' on screen. The log file
  244.                          contains  a  list  of  all user operations that
  245.                          have been made.
  246.  
  247. [D]elete user log
  248.                          Asks for a confirm. Deletes the file 'log' from
  249.                          disk and creates a blank log file.
  250.  
  251. [M]essages delete
  252.                          Asks for a confirm. Deletes the file 'messages'
  253.                          from disk and creates a blank message file.
  254.  
  255. [C]omments delete
  256.                          Asks for a confirm. Deletes the file 'comments'
  257.                          from disk and creates a blank comments file.
  258.  
  259. [P]assword change
  260.                          Prompts you for a new 'user password'. Warning;
  261.                          Password  changes  are lost when the NHS script
  262.                          is stopped. Edit the file 'host.script' to make
  263.                          changes permanent.
  264.  
  265. [S]ysop password change
  266.                          Prompts  you  for  the 'sysop password'. If the
  267.                          password  is  correct,  the command will prompt
  268.                          you  for  a  new  password.  Warning;  Password
  269.                          changes   are  lost  when  the  NHS  script  is
  270.                          stopped.  Edit  the  file 'host.script' to make
  271.                          changes permanent.
  272.  
  273. [E]xecute DOS command
  274.                          Prompts you for a DOS command. The command will
  275.                          be   executed   and   program  output  will  be
  276.                          displayed on screen.
  277.  
  278. [Q]uit to main menu
  279.                          Quits to main menu.
  280.